<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <style xmlns="" type="text/css">
    /* This style sets a margin around the entire page */
        html, body {
            margin: 10px;
        }

        p {
            font: normal 16px verdana, sans-serif;
            margin: 0;
            padding-bottom:12px;
        }

        h1 {
            font: bold 25px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        h2 {
            font: bold 19px verdana, sans-serif;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0; 
            padding-bottom: 0;
        }

        h3 {
            font: bold 19px verdana, sans-serif !important;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        li {
            font: normal 16px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 18px;
            padding-top: 0;
            padding-bottom: 0;
        }

        .pdparam {
            font: italic 16px verdana, sans-serif;
        }
		
		.term {
			font: italic 16px verdana, sans-serif;
			font-weight: normal;
		}	
		
		.type {
			font: normal 16px verdana, sans-serif !important;
		}			
		
		.parameter { 
			font-style: italic; 
			}

        a:link, a:visited {
            color: blue;
            text-decoration: none;
            font: normal 16px;
        }

        a:hover {
            background-color: #FFFF99;
            font: normal 16px;
        }

        div.funcsynopsis {
            text-align: left;
            background-color: #e6e6e6;
            font: normal 16px verdana, sans-serif;
			padding-top: 10px;
			padding-bottom: 10px;
        }

        div.funcsynopsis table {
            border-collapse: separate;
            font: normal 16px verdana, sans-serif;
        }

        div.funcsynopsis td {
            background-color: #e6e6e6;
            border: 0 solid #000;
            padding: 1px;
            font: normal 16px verdana, sans-serif;
        }

        div.refsect1 {
            font-family: verdana, sans-serif;
            font-size: 16px;
        }

        code.constant {
            font: normal 16px courier new, monospace !important;
        }
		
		span.errorname {
            font: normal 16px verdana, sans-serif !important;
        }

        code.function {
            font: bold 16px verdana, sans-serif !important;
        }
		
        b.fsfunc {
            font: bold 16px verdana, sans-serif !important;
        }
		
        code.varname {
            font: italic 16px verdana, sans-serif;
        }

        code.replaceable {
            font: italic 16px courier new, monospace;
        }

        code.funcdef {
            font: normal 16px verdana, sans-serif !important;
        }

        .citerefentry {
            font: normal 16px verdana, sans-serif !important;
        }

        .parameter {
            font-style: italic;
        }

        code.fsfunc {
            font: normal 16px verdana, sans-serif !important;
        }

        /* PARAMETER: This style controls spacing between the terms in Parameter section */
        dt {
            margin-top: 15px;
        }

        /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
        div.refsect1 table {
            width: 100%;
			margin-top: 10px;
            background-color: #FFF;
			border-collapse: collapse;
			border-color: #000;
            border-width: 1px;
			font: normal 16px verdana, sans-serif;
        }
		
        div.refsect1 th {
			border-collapse: collapse;
			border-color: #000;
            border-width: 1px;
            font: bold 16px verdana, sans-serif;
        }
		
        div.refsect1 td {
            background-color: #FFF;
            padding: 5px;
            vertical-align: text-top;
			border-collapse: collapse;
			border-color: #000;
            border-width: 1px;
            font: normal 16px verdana, sans-serif;
        }
		
		  div.refsect1 p{
            font: normal 16px verdana, sans-serif;
            margin-top: 8px;
            margin-bottom: 8px;
            padding-top: 0;
            padding-bottom: 0;
        }
		

        /* EXAMPLE: These styles apply only to the Example section */
        div.refsect2 {
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 table {
            margin-top: 0;
            background-color: #e6e6e6;
            width: 100%;
            border: 0 solid #000;
            padding: 2px;
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 td {
            background-color: #e6e6e6;
            font: normal 16px courier new, monospace !important;
			white-space:pre;
        }

        /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
        div.refsect3 {
            font: normal 11px verdana, sans-serif;
            margin-top: 50px;
            margin-bottom: 20px;
            padding-top: 0;
            padding-bottom: 0;
        }
					
</style>
    <title>Image Read and Write Functions</title>
    <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
    <meta name="keywords" content="Image Read and Write Functions" />
  </head>
  <body>
    <div class="refentry">
      <a id="idm1"></a>
      <div class="titlepage"></div>
      <div xmlns="" class="refnamediv">
        <h1>Image Read and Write Functions</h1>
        <p>Click an item in the table below for details about that function.</p>
      </div>
      <div class="refsect1">
        <a id="springboard"></a>
        <h2></h2>
        <div class="informaltable">
          <table class="informaltable" border="1">
            <colgroup>
              <col align="left" class="col1" />
              <col align="left" class="col2" />
            </colgroup>
            <tbody>
              <tr>
                <td align="left"><a class="citerefentry" href="read_imagef2d.html"><span class="citerefentry"><span class="refentrytitle">read_imagef</span></span></a> for 1D and 2D</td>
                <td align="left">Do an element lookup in the 1D or 2D image object, returning floating-point values</td>
              </tr>
              <tr>
                <td align="left"><a class="citerefentry" href="read_imagei2d.html"><span class="citerefentry"><span class="refentrytitle">read_image{i|ui}</span></span></a> for 1D and 2D</td>
                <td align="left">Do an element lookup in the 1D or 2D image object, returning unnormalized signed integer and unsigned integer values</td>
              </tr>
              <tr>
                <td align="left"><a class="citerefentry" href="read_imageh2d.html"><span class="citerefentry"><span class="refentrytitle">read_imageh</span></span></a> for 1D and 2D</td>
                <td align="left">OPTIONAL function to do an element lookup in the 1D or 2D image object, returning floating-point values. Enabled with <a class="citerefentry" href="cl_khr_fp16.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp16</span></span></a>.</td>
              </tr>
              <tr>
                <td align="left"><a class="citerefentry" href="write_image.html"><span class="citerefentry"><span class="refentrytitle">write_image {f|i|ui}</span></span></a>  for 1D and 2D</td>
                <td align="left">Write <code class="varname">color</code> value to location in the 1D or 2D image object</td>
              </tr>
              <tr>
                <td align="left"><a class="citerefentry" href="write_imageh2d.html"><span class="citerefentry"><span class="refentrytitle">write_imageh</span></span></a> for 1D and 2D</td>
                <td align="left">OPTIONAL function to write <code class="varname">color</code> value in a 1D or 3D object. Enabled with <a class="citerefentry" href="cl_khr_fp16.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp16</span></span></a>.</td>
              </tr>
              <tr>
                <td align="left"><a class="citerefentry" href="read_imagef3d.html"><span class="citerefentry"><span class="refentrytitle">read_imagef</span></span></a> for 3D</td>
                <td align="left">Do an element lookup in the 3D image object, returning floating-point values</td>
              </tr>
              <tr>
                <td align="left"><a class="citerefentry" href="read_imagei3d.html"><span class="citerefentry"><span class="refentrytitle">read_imagei</span></span></a> for 3D</td>
                <td align="left">Do an element lookup in the 3D image object, returning unnormalized signed integer and unsigned integer values</td>
              </tr>
              <tr>
                <td align="left"><a class="citerefentry" href="read_imageh3d.html"><span class="citerefentry"><span class="refentrytitle">read_imageh</span></span></a> for 3D</td>
                <td align="left">Do an element lookup in the 3D image object, returning half floating point values. Enabled with <a class="citerefentry" href="cl_khr_fp16.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp16</span></span></a>.</td>
              </tr>
              <tr>
                <td align="left"><a class="citerefentry" href="write_imageh3d.html"><span class="citerefentry"><span class="refentrytitle">write_imageh</span></span></a> for 3D</td>
                <td align="left">OPTIONAL function to write <code class="varname">color</code> value in a 3D object. Enabled with <a class="citerefentry" href="cl_khr_fp16.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp16</span></span></a>.</td>
              </tr>
              <tr>
                <td align="left"><a class="citerefentry" href="cl_khr_3d_image_writes.html"><span class="citerefentry"><span class="refentrytitle">write_image{f i ui}</span></span></a> for 3D</td>
                <td align="left">OPTIONAL function to write <code class="varname">color</code> value in a 3D object. Enabled with <a class="citerefentry" href="cl_khr_3d_image_writes.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_3d_image_writes</span></span></a>.</td>
              </tr>
              <tr>
                <td align="left">
                  <a class="citerefentry" href="get_image_width.html">
                    <span class="citerefentry">
                      <span class="refentrytitle">get_image_width</span>
                    </span>
                  </a>
                </td>
                <td align="left">Return the 2D or 3D image width in pixels</td>
              </tr>
              <tr>
                <td align="left">
                  <a class="citerefentry" href="get_image_height.html">
                    <span class="citerefentry">
                      <span class="refentrytitle">get_image_height</span>
                    </span>
                  </a>
                </td>
                <td align="left">Return the 2D or 3D image height in pixels.</td>
              </tr>
              <tr>
                <td align="left">
                  <a class="citerefentry" href="get_image_depth.html">
                    <span class="citerefentry">
                      <span class="refentrytitle">get_image_depth</span>
                    </span>
                  </a>
                </td>
                <td align="left">Return the 3D image depth in pixels</td>
              </tr>
              <tr>
                <td align="left">
                  <a class="citerefentry" href="get_image_channel_data_type.html">
                    <span class="citerefentry">
                      <span class="refentrytitle">get_image_channel_data_type</span>
                    </span>
                  </a>
                </td>
                <td align="left">Return the image channel data type</td>
              </tr>
              <tr>
                <td align="left">
                  <a class="citerefentry" href="get_image_channel_order.html">
                    <span class="citerefentry">
                      <span class="refentrytitle">get_image_channel_order</span>
                    </span>
                  </a>
                </td>
                <td align="left">Return the image channel order</td>
              </tr>
              <tr>
                <td align="left">
                  <a class="citerefentry" href="get_image_dim.html">
                    <span class="citerefentry">
                      <span class="refentrytitle">get_image_dim</span>
                    </span>
                  </a>
                </td>
                <td align="left">Return the image dimensions</td>
              </tr>
            </tbody>
          </table>
        </div>
      </div>
      <div class="refsect1">
        <a id="description"></a>
        <h2>Description</h2>
        <p>
			The built-in image function calls to read and write images are supported.. 
        </p>
        <p>
		The generic type <span class="type">gentype</span> is used to indicate the built-in data types
<span class="type">char</span>, <span class="type">uchar</span>, <span class="type">short</span>, <span class="type">ushort</span>, <span class="type">int</span>, <span class="type">uint</span>, <span class="type">long</span>, <span class="type">ulong</span>, or <span class="type">float</span>. 
        </p>
        <p>
The generic type name <span class="type">gentype<em class="replaceable"><code>n</code></em></span> is used to indicate the built-in data types <span class="type">char{2|4|8|16}</span>, <span class="type">uchar{2|4|8|16}</span>, <span class="type">short{2|4|8|16}</span>, <span class="type">ushort{2|4|8|16}</span>, <span class="type">int{2|4|8|16}</span>, <span class="type">uint{2|4|8|16}</span>, <span class="type">long{2|4|8|16}</span>, <span class="type">ulong{2|4|8|16}</span>, or <span class="type">float{2|4|8|16}</span> as the type for the arguments unless otherwise stated. 
        </p>
        <p>
The suffix used in gentype<em class="replaceable"><code>n</code></em> or the function name (i.e. <a class="citerefentry" href="vloadn.html"><span class="citerefentry"><span class="refentrytitle">vload<em class="replaceable"><code>n</code></em></span></span></a>, <a class="citerefentry" href="vstoren.html"><span class="citerefentry"><span class="refentrytitle">vstore<em class="replaceable"><code>n</code></em></span></span></a>, etc.) represents the number of elements in the built-in vector type (<em class="replaceable"><code>n</code></em> = 2, 4, 8, or 16).
        </p>
        <p>
The image read and write functions are extended with <a class="citerefentry" href="cl_khr_fp16.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp16</span></span></a> to include appropriate versions of functions that take <span class="type">half4</span> as arguments and return values. 
		</p>
      </div>
      <div class="refsect1">
        <a id="specification"></a>
        <h2>Specification</h2>
        <p>
            <img src="pdficon_small1.gif" />
                                                 
            <a href="http://www.khronos.org/registry/cl/specs/opencl-1.0.pdf#page=190" target="OpenCL Spec">OpenCL Specification</a>
        </p>
      </div>
      <div class="refsect1">
        <a id="seealso"></a>
        <h2>Also see</h2>
        <p>
            <a class="citerefentry" href="sampler_t.html"><span class="citerefentry"><span class="refentrytitle">sampler_t</span></span></a>, <a class="citerefentry" href="cl_khr_3d_image_writes.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_3d_image_writes</span></span></a>
        </p>
      </div>
      <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2009 The Khronos Group Inc. 
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials. 
</div>
    </div>
  </body>
</html>
